Microsoft Marketplace Search API (preview:2023-01-01)

2025/06/04 • 3 updated methods

Facets_Get (updated)
Description :  Get counts of Marketplace public products with requested properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Facets_Get",
  "Summary": {
    "new": "Get counts of Marketplace public products with requested properties.",
    "old": "Public Facets API provides an unauthenticated endpoint for consuming list of Marketplace public products counts per requested properties. In addition, it enables filtering on selected product\u202fproperties, search, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
  }
}

⚼ Request

GET:  /facets
{
api-version:
{
Description: Version of the REST API used for the request. ,
Required: True ,
}
string ,
searchQuery:
{
Description: The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored. ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. - `Eligible`: Eligible. - `NotEligible`: Not Eligible. ,
Required: False ,
}
string ,
publisherTypes:
{
Description: Products that contains any of the given publisher types, If no value provided, this filter is ignored. Possible values: Microsoft, ThirdParty. Default: Microsoft. - `Microsoft`: Microsoft. - `ThirdParty`: Third Party. ,
Required: False ,
}
array ,
badges:
{
Description: Products that contains any of the given badges. If no value provided, this filter is ignored. The following product badges are available: - `PreferredSolution`: Preferred Solution. - `PowerBICertified`: power BI Certified. - `AdditionalPurchaseRequirement`: Additional Purchase Requirement. ,
Required: False ,
}
array ,
industryCloud:
{
Description: Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. - `NotApplicable`: Not Applicable. - `True`: True. - `False`: False. ,
Required: False ,
}
string ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant' ,
Required: True ,
}
string ,
productTypes:
{
Description: Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. - `AADApps`: Azure Active Directory Apps. - `AzureApplication`: Azure Application. - `AzureServices`: Azure Services. - `ConsultingServices`: Consulting Services. - `Container`: Container. - `ContainerApps`: Container Apps. - `CoreVirtualMachine`: Core Virtual Machine. - `CosellOnly`: Cosell Only. - `DevService`: Dev Service. - `DynamicsBC`: Dynamics BC. - `DynamicsCE`: Dynamics CE. - `DynamicsOps`: Dynamics Ops. - `IotEdgeModules`: Iot Edge Modules. - `ManagedApplication`: Managed Application. - `ManagedServices`: Managed Services. - `Office365`: Office365. - `PowerBI`: PowerBI. - `PowerBIVisuals`: PowerBI Visuals. - `SaaS`: SaaS. - `SolutionTemplate`: Solution Template. - `VirtualMachine`: Virtual Machine. - `VisualStudioExtension`: Visual Studio Extension. - `AppService`: App Service. - `LogAnalytics`: Log Analytics. ,
Required: False ,
}
array ,
pricingTypes:
{
Description: Products that contains any of the given pricing types. If no value provided, this filter is ignored. - `Byol`: The product has at least one plan that is bring your own license. - `Free`: The product has at least one plan that is free of charge. - `FreeTrial`: The product has at least one plan that is free trial. - `Payg`: The product has at least one plan that is Pay as you go, usage based billing model. - `RI`: The product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
array ,
operatingSystems:
{
Description: Products that contains any of the given operating systems, Such as operatingSystems=windows,linux. If no value provided, this filter is ignored. This filter is relevant for Virtual Machine product type only. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2016`: Windows Server 2016. - `windows.windowsserver2012r2`: Windows Server 2012 R2. - `windows.windowsserver2012`: Windows Server 2012. - `windows.windowsserver2008r2`: Windows Server 2008 R2. - `windows.others`: Others (windows). - `windows.windowsserver2022`: Windows Server 2022. - `linux.centos`: Cent OS. - `linux.debian`: Debian. - `linux.redhat`: Red Hat. - `linux.suse`: SUSE. - `linux.ubuntu`: Ubuntu. - `linux.others`: Others (Linux). ,
Required: False ,
}
array ,
hideKeys:
{
Description: Products that contains any of the given hideKeys for preview. Such as '22c6b3ae-1111-1111-1111-e7cbdc8569dd'. If no value provided, this filter is ignored. This filter is applied only when PublishingStage filter is set to Preview. ,
Required: False ,
}
array ,
market:
{
Description: Product sold market, Possible values - https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies or 'All' for all markets. Such as 'US' ,
Required: True ,
}
string ,
supportedProducts:
{
Description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
publisherIds:
{
Description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
ratingBuckets:
{
Description: Products that contains any of the given rating buckets. Such as 'Above1'. If no value provided, this filter is ignored. - `AboveOne`: Above One. - `AboveTwo`: Above Two. - `AboveThree`: Above Three. - `AboveFour`: Above Four ,
Required: False ,
}
array ,
vmArchitectureTypes:
{
Description: Array of Virtual Machine image architecture types to search by, If no value provided, this filter is ignored. see https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2: - `X64Gen1`: X64 Generation 1. - `X64Gen2`: X64 Generation 2. - `Arm64`: Arm64 image architecture. ,
Required: False ,
}
array ,
vmSecurityTypes:
{
Description: Products that contains any of the given vm security types. Such as 'Trusted'. If no value provided, this filter is ignored. - `None`: None. - `Trusted`: Trusted. - `Confidential`: Confidential ,
Required: False ,
}
array ,
publishingStage:
{
Description: Audience. Default: Public. - `Preview`: Preview. - `Public`: Public ,
Required: False ,
}
string ,
facets:
{
Description: Array facets to facet by, if none provided then no facets will return. Such as facets=PricingTypes,operatingSystems. - `SupportedProducts`: Supported Products. - `PublisherType`: Publisher Type. - `AzureBenefit`: Azure Benefit. - `ProductType`: Product Type. - `OperatingSystems`: Operating Systems. - `PricingTypes`: Pricing Types. - `VmImageGenerations`: Vm Image Generations. - `VmSecurityTypes`: Vm Security Types. - `VmArchitectureTypes`: Vm Architecture Types. - `RatingBuckets`: Rating Buckets. ,
Required: True ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The facet items results ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The search error response object ,
}
{
error:
{
Description: The search error response details ,
Required: False ,
}
string ,
}
,
}
Search_Get (updated)
Description :  Serves a user experience with search and filter results on Marketplace public products.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Search_Get",
  "Summary": {
    "new": "Serves a user experience with search and filter results on Marketplace public products.",
    "old": "Public Search API provides an unauthenticated endpoint for consuming list of Marketplace public products, total count of products returned, and facets per requested properties. In addition, it enables filtering on selected product\u202fproperties, search, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
  }
}

⚼ Request

GET:  /search
{
api-version:
{
Description: Version of the REST API used for the request. ,
Required: True ,
}
string ,
searchQuery:
{
Description: The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored. ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. - `Eligible`: Eligible. - `NotEligible`: Not Eligible. ,
Required: False ,
}
string ,
publisherTypes:
{
Description: Products that contains any of the given publisher types, If no value provided, this filter is ignored. Possible values: Microsoft, ThirdParty. Default: Microsoft. - `Microsoft`: Microsoft. - `ThirdParty`: Third Party. ,
Required: False ,
}
array ,
badges:
{
Description: Products that contains any of the given badges. If no value provided, this filter is ignored. The following product badges are available: - `PreferredSolution`: Preferred Solution. - `PowerBICertified`: power BI Certified. - `AdditionalPurchaseRequirement`: Additional Purchase Requirement. ,
Required: False ,
}
array ,
industryCloud:
{
Description: Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. - `NotApplicable`: Not Applicable. - `True`: True. - `False`: False. ,
Required: False ,
}
string ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant' ,
Required: True ,
}
string ,
select:
{
Description: Array of fields to return. Such as select=pricingTypes. - `All`: All fields. - `SupportedProducts`: Supported Products. - `PublisherId`: Publisher Id. - `DisplayName`: Display Name. - `AzureBenefit`: Azure Benefit. - `Badges`: Badges. - `SmallIconUri`: Small Icon Uri. - `PublisherType`: Publisher Type. - `PublishingState`: Publishing State. - `UniqueProductId`: Unique Product Id. - `ProductType`: Product Type. - `Plans`: Plans. - `OperatingSystems`: Operating Systems. - `PricingTypes`: Pricing Types. - `PublisherDisplayName`: Publisher Display Name. - `Summary`: Summary. - `Description`: Description. - `RatingBuckets`: Rating Buckets. - `RatingAverage`: Rating Average. - `LastModifiedDateTime`: Last Modified time. - `RatingCount`: Rating Count. - `LongSummary`: Long Summary. ,
Required: True ,
}
array ,
orderBy:
{
Description: Array of sort by fields to order by and ordering type (asc\desc), If no value provided, ordered by search score. Default ordering type: asc. For example, orderby=RatingCount desc. - `RatingCount`: ratingCount (asc/desc). - `LastModifiedDateTime`: lastModifiedDateTime (asc/desc). - `RatingAverage`: RatingAverage (asc/desc). ,
Required: False ,
}
array ,
productTypes:
{
Description: Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. - `AADApps`: Azure Active Directory Apps. - `AzureApplication`: Azure Application. - `AzureServices`: Azure Services. - `ConsultingServices`: Consulting Services. - `Container`: Container. - `ContainerApps`: Container Apps. - `CoreVirtualMachine`: Core Virtual Machine. - `CosellOnly`: Cosell Only. - `DevService`: Dev Service. - `DynamicsBC`: Dynamics BC. - `DynamicsCE`: Dynamics CE. - `DynamicsOps`: Dynamics Ops. - `IotEdgeModules`: Iot Edge Modules. - `ManagedApplication`: Managed Application. - `ManagedServices`: Managed Services. - `Office365`: Office365. - `PowerBI`: PowerBI. - `PowerBIVisuals`: PowerBI Visuals. - `SaaS`: SaaS. - `SolutionTemplate`: Solution Template. - `VirtualMachine`: Virtual Machine. - `VisualStudioExtension`: Visual Studio Extension. - `AppService`: App Service. - `LogAnalytics`: Log Analytics. ,
Required: False ,
}
array ,
pricingTypes:
{
Description: Products that contains any of the given pricing types. If no value provided, this filter is ignored. - `Byol`: The product has at least one plan that is bring your own license. - `Free`: The product has at least one plan that is free of charge. - `FreeTrial`: The product has at least one plan that is free trial. - `Payg`: The product has at least one plan that is Pay as you go, usage based billing model. - `RI`: The product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
array ,
operatingSystems:
{
Description: Products that contains any of the given operating systems, Such as operatingSystems=windows,linux. If no value provided, this filter is ignored. This filter is relevant for Virtual Machine product type only. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2016`: Windows Server 2016. - `windows.windowsserver2012r2`: Windows Server 2012 R2. - `windows.windowsserver2012`: Windows Server 2012. - `windows.windowsserver2008r2`: Windows Server 2008 R2. - `windows.others`: Others (windows). - `windows.windowsserver2022`: Windows Server 2022. - `linux.centos`: Cent OS. - `linux.debian`: Debian. - `linux.redhat`: Red Hat. - `linux.suse`: SUSE. - `linux.ubuntu`: Ubuntu. - `linux.others`: Others (Linux). ,
Required: False ,
}
array ,
hideKeys:
{
Description: Products that contains any of the given hideKeys for preview. Such as '22c6b3ae-1111-1111-1111-e7cbdc8569dd'. If no value provided, this filter is ignored. This filter is applied only when PublishingStage filter is set to Preview. ,
Required: False ,
}
array ,
market:
{
Description: Product sold market, Possible values - https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies or 'All' for all markets. Such as 'US' ,
Required: True ,
}
string ,
supportedProducts:
{
Description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
publisherIds:
{
Description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
ratingBuckets:
{
Description: Products that contains any of the given rating buckets. Such as 'Above1'. If no value provided, this filter is ignored. - `AboveOne`: Above One. - `AboveTwo`: Above Two. - `AboveThree`: Above Three. - `AboveFour`: Above Four ,
Required: False ,
}
array ,
vmArchitectureTypes:
{
Description: Array of Virtual Machine image architecture types to search by, If no value provided, this filter is ignored. see https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2: - `X64Gen1`: X64 Generation 1. - `X64Gen2`: X64 Generation 2. - `Arm64`: Arm64 image architecture. ,
Required: False ,
}
array ,
vmSecurityTypes:
{
Description: Products that contains any of the given vm security types. Such as 'Trusted'. If no value provided, this filter is ignored. - `None`: None. - `Trusted`: Trusted. - `Confidential`: Confidential ,
Required: False ,
}
array ,
publishingStage:
{
Description: Audience. Default: Public. - `Preview`: Preview. - `Public`: Public ,
Required: False ,
}
string ,
facets:
{
Description: Array facets to facet by, if none provided then no facets will return. Such as facets=PricingTypes,operatingSystems. - `SupportedProducts`: Supported Products. - `PublisherType`: Publisher Type. - `AzureBenefit`: Azure Benefit. - `ProductType`: Product Type. - `OperatingSystems`: Operating Systems. - `PricingTypes`: Pricing Types. - `VmImageGenerations`: Vm Image Generations. - `VmSecurityTypes`: Vm Security Types. - `VmArchitectureTypes`: Vm Architecture Types. - `RatingBuckets`: Rating Buckets. ,
Required: False ,
}
array ,
skip:
{
Description: Number of items to skip. Minimum: 0, Maximum: 100000, Default : 0. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of items to return. Minimum: 0, Maximum: 1000, Default: 20. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
facets:
{
Description: The search facets ,
Required: False ,
}
object ,
results:
{
Description: The results ,
Required: True ,
}
[
{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Possible values: - `Eligible` - Product is eligible for Azure consumption commitment benefit - `NotEligible` - Product is not eligible for Azure consumption commitment benefit ,
Required: False ,
}
string ,
badges:
{
Description: The following product badges are available: preferredSolution, powerBICertified, AdditionalPurchaseRequirement ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: A value indicating whether this is a Microsoft or third party product. Possible values: - `Microsoft` - Product is published by Microsoft (1st party product) - `Third Party` - Product is published by Third Party Vendor ,
Required: False ,
}
string ,
publishingStage:
{
Description: Product publishing stage. Possible values: - `Preview` - Product is available to restricted audience - `Public` - Product is publicly available in the Marketplace ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: False ,
}
string ,
productType:
{
Description: The delivery method or deployment model. Possible values: - `SaaS` - The product is a Software solution purchased on pay-as-you-go basis from a cloud service provider - `VirtualMachine` - The product is Image service instances with usage-based pricing - `AzureApplication` - Products published as Solution Templates (ST) or Azure Managed Apps (AMA) plans that deploy Azure resources to the customer tenant - `DynamicsCE` - All Dynamics products except for DynamicsBC and DynamicsOps - `DynamicsBC` - Dynamics 365 business Central - `Container` - The product is delivered as Container - `DynamicsOps` - Dynamics 365 Operations Apps - `None` - Product type returned for Azure Services, Container Extensions and VM extensions - `IotEdgeModules` - Resource is delivered as IoT Edge Module - `ContainerApps` - Resource is delivered as Container App - `ConsultingServices` Consulting Services (available only in Azure Marketplace as listing offers) - `ManagedServices` - The product is delivered as Managed Service - `PowerBI` - Power BI products - `CosellOnly` - Products available in scope of Co-Sell program only - `PowerBIVisuals` - Power BI Visuals products - `Office365` - Office 365 products - `DevService` - Dev Service - `AADApps` - Azure Active Directory Applications - `VisualStudioExtension` - Visual Studio Extensions ,
Required: True ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: The list of the pricing types for which this offer is designated. Possible Values: - `Free` - Product has at least one plan that is free of charge. - `FreeTrial` - Product has at least one plan that is free trial. - `Byol` - Product has at least one plan that is bring your own license. - `Payg` - Product has at least one plan that is Pay as you go, usage based billing model. - `Ri` - Product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
linkedAddInsTypes:
{
Description: Linked add-in types ,
Required: False ,
}
object ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Rating buckets, Above1, Above2, Above3, Above4 ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
startingPrice:
{
Description: Retail price of the product's cheapest plan ,
Required: False ,
}
string ,
plans:
{
Description: List of plans that are available for this product ,
Required: False ,
}
[
{
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan Id which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: VM Architecture Type. Applicable to Virtual Machine products only. PossibleValues: - `Arm64` - The VM image architecture of the plan is Arm64 - `X64Gen1` - The VM image architecture of the plan is X64 Generation1 - `X64Gen2` - The VM image architecture of the plan is X64 Generation2 ,
Required: False ,
}
string ,
cspState:
{
Description: A value indicating whether the product is available for purchase through CSP channel ,
Required: False ,
}
string ,
metadata:
{
Description: Additional plan metadata ,
Required: False ,
}
string ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: The list of the pricing types for which this plan is designated (Possible values are the same as at product level) ,
Required: False ,
}
[
string ,
]
,
vmSecurityTypes:
{
Description: VM security type. Applicable to Virtual Machine products only. Possible values: - `None` - `Trusted` - protects against persistent and advanced attacks on Gen2 virtual machines with configurable features like security boot and virtual Trusted Platform Module(vTPM) - `Confidential` - on top of Trusted Launch, Confidential virtual machines offer higher confidentiality and integrity guaranteed with hardware-based trusted execution environment ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Managed Application or Solution template plan type (applicable only to Azure Applications product). Possible values : - `SolutionTemplate` - Solution Template plan type (applicable to Azure Applications only) - `ManagedApplication` - Managed Application plan type (applicable to Azure Applications only) ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table (as configured by the publisher) ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
}
,
]
,
supportedProducts:
{
Description: Maps to the list of compatible products that the publisher provides ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Description: The total count ,
Format: int64 ,
Required: False ,
}
integer ,
showingResultsFor:
{
Description: The showing results for ,
Required: False ,
}
string ,
nextLink:
{
Description: URL to get the next page of API search ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The search error response object ,
}
{
error:
{
Description: The search error response details ,
Required: False ,
}
string ,
}
,
}
Suggestions_GetProducts (updated)
Description :  Make suggestions while user is typing a search query for products.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Suggestions_GetProducts",
  "Summary": {
    "new": "Make suggestions while user is typing a search query for products.",
    "old": "Public Suggestions API provides an unauthenticated endpoint for consuming list of Marketplace public products suggestions per requested properties. In addition, it enables filtering on selected product\u202fproperties, and getting product details. Each API request must include an API key allocated to you (see X-API-Key description). Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
  }
}

⚼ Request

GET:  /suggestions/products
{
api-version:
{
Description: Version of the REST API used for the request. ,
Required: True ,
}
string ,
searchQuery:
{
Description: The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat ,
Required: True ,
}
string ,
publisherDisplayName:
{
Description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored. ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. - `Eligible`: Eligible. - `NotEligible`: Not Eligible. ,
Required: False ,
}
string ,
publisherTypes:
{
Description: Products that contains any of the given publisher types, If no value provided, this filter is ignored. Possible values: Microsoft, ThirdParty. Default: Microsoft. - `Microsoft`: Microsoft. - `ThirdParty`: Third Party. ,
Required: False ,
}
array ,
badges:
{
Description: Products that contains any of the given badges. If no value provided, this filter is ignored. The following product badges are available: - `PreferredSolution`: Preferred Solution. - `PowerBICertified`: power BI Certified. - `AdditionalPurchaseRequirement`: Additional Purchase Requirement. ,
Required: False ,
}
array ,
industryCloud:
{
Description: Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. - `NotApplicable`: Not Applicable. - `True`: True. - `False`: False. ,
Required: False ,
}
string ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant' ,
Required: True ,
}
string ,
productTypes:
{
Description: Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. - `AADApps`: Azure Active Directory Apps. - `AzureApplication`: Azure Application. - `AzureServices`: Azure Services. - `ConsultingServices`: Consulting Services. - `Container`: Container. - `ContainerApps`: Container Apps. - `CoreVirtualMachine`: Core Virtual Machine. - `CosellOnly`: Cosell Only. - `DevService`: Dev Service. - `DynamicsBC`: Dynamics BC. - `DynamicsCE`: Dynamics CE. - `DynamicsOps`: Dynamics Ops. - `IotEdgeModules`: Iot Edge Modules. - `ManagedApplication`: Managed Application. - `ManagedServices`: Managed Services. - `Office365`: Office365. - `PowerBI`: PowerBI. - `PowerBIVisuals`: PowerBI Visuals. - `SaaS`: SaaS. - `SolutionTemplate`: Solution Template. - `VirtualMachine`: Virtual Machine. - `VisualStudioExtension`: Visual Studio Extension. - `AppService`: App Service. - `LogAnalytics`: Log Analytics. ,
Required: False ,
}
array ,
pricingTypes:
{
Description: Products that contains any of the given pricing types. If no value provided, this filter is ignored. - `Byol`: The product has at least one plan that is bring your own license. - `Free`: The product has at least one plan that is free of charge. - `FreeTrial`: The product has at least one plan that is free trial. - `Payg`: The product has at least one plan that is Pay as you go, usage based billing model. - `RI`: The product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
array ,
operatingSystems:
{
Description: Products that contains any of the given operating systems, Such as operatingSystems=windows,linux. If no value provided, this filter is ignored. This filter is relevant for Virtual Machine product type only. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2019`: Windows Server 2019. - `windows.windowsserver2016`: Windows Server 2016. - `windows.windowsserver2012r2`: Windows Server 2012 R2. - `windows.windowsserver2012`: Windows Server 2012. - `windows.windowsserver2008r2`: Windows Server 2008 R2. - `windows.others`: Others (windows). - `windows.windowsserver2022`: Windows Server 2022. - `linux.centos`: Cent OS. - `linux.debian`: Debian. - `linux.redhat`: Red Hat. - `linux.suse`: SUSE. - `linux.ubuntu`: Ubuntu. - `linux.others`: Others (Linux). ,
Required: False ,
}
array ,
supportedProducts:
{
Description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
publisherIds:
{
Description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored. ,
Required: False ,
}
array ,
ratingBuckets:
{
Description: Products that contains any of the given rating buckets. Such as 'Above1'. If no value provided, this filter is ignored. - `AboveOne`: Above One. - `AboveTwo`: Above Two. - `AboveThree`: Above Three. - `AboveFour`: Above Four ,
Required: False ,
}
array ,
vmArchitectureTypes:
{
Description: Array of Virtual Machine image architecture types to search by, If no value provided, this filter is ignored. see https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2: - `X64Gen1`: X64 Generation 1. - `X64Gen2`: X64 Generation 2. - `Arm64`: Arm64 image architecture. ,
Required: False ,
}
array ,
vmSecurityTypes:
{
Description: Products that contains any of the given vm security types. Such as 'Trusted'. If no value provided, this filter is ignored. - `None`: None. - `Trusted`: Trusted. - `Confidential`: Confidential ,
Required: False ,
}
array ,
suggestionTypes:
{
Description: Suggestion types. - `WordSearch`: WordSearch. - `Entity`: Entity. ,
Required: True ,
}
array ,
top:
{
Description: Number of items per SuggestionType to return. Minimum: 1, Maximum: 40, Default: 20. ,
Format: int32 ,
Required: False ,
}
integer ,
select:
{
Description: Array of fields to return. Such as 'displayText'. If no value provided, return fields as follows. if suggestionsType=Entity, return: suggestionType, displayText, id. if suggestionType=WordSearch, return suggestionType and displayText. - `DisplayText`: Display text. - `Id`: Id. - `IconUrl`: Icon Url. - `ProductType`: Product type. - `LinkedAddInsTypes`: Linked AddIns types. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The suggestion items results ,
Required: True ,
}
[
{
suggestionType:
{
Description: The suggestion type ,
Required: False ,
}
string ,
displayText:
{
Description: The suggestion display text ,
Required: True ,
}
string ,
id:
{
Description: The suggestion item id ,
Required: False ,
}
string ,
iconUrl:
{
Description: The suggestion icon url ,
Required: False ,
}
string ,
productType:
{
Description: The suggestion supported product types ,
Required: False ,
}
string ,
linkedAddInsTypes:
{
Description: The suggestion linked add-in types ,
Required: False ,
}
object ,
}
,
]
,
totalCount:
{
Description: The suggestion count ,
Format: int64 ,
Required: True ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The search error response object ,
}
{
error:
{
Description: The search error response details ,
Required: False ,
}
string ,
}
,
}